<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/**<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Copyright (c) 2004-2011 QOS.ch<a name="line.2"></a>
<span class="sourceLineNo">003</span> * All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * Permission is hereby granted, free  of charge, to any person obtaining<a name="line.5"></a>
<span class="sourceLineNo">006</span> * a  copy  of this  software  and  associated  documentation files  (the<a name="line.6"></a>
<span class="sourceLineNo">007</span> * "Software"), to  deal in  the Software without  restriction, including<a name="line.7"></a>
<span class="sourceLineNo">008</span> * without limitation  the rights to  use, copy, modify,  merge, publish,<a name="line.8"></a>
<span class="sourceLineNo">009</span> * distribute,  sublicense, and/or sell  copies of  the Software,  and to<a name="line.9"></a>
<span class="sourceLineNo">010</span> * permit persons to whom the Software  is furnished to do so, subject to<a name="line.10"></a>
<span class="sourceLineNo">011</span> * the following conditions:<a name="line.11"></a>
<span class="sourceLineNo">012</span> *<a name="line.12"></a>
<span class="sourceLineNo">013</span> * The  above  copyright  notice  and  this permission  notice  shall  be<a name="line.13"></a>
<span class="sourceLineNo">014</span> * included in all copies or substantial portions of the Software.<a name="line.14"></a>
<span class="sourceLineNo">015</span> *<a name="line.15"></a>
<span class="sourceLineNo">016</span> * THE  SOFTWARE IS  PROVIDED  "AS  IS", WITHOUT  WARRANTY  OF ANY  KIND,<a name="line.16"></a>
<span class="sourceLineNo">017</span> * EXPRESS OR  IMPLIED, INCLUDING  BUT NOT LIMITED  TO THE  WARRANTIES OF<a name="line.17"></a>
<span class="sourceLineNo">018</span> * MERCHANTABILITY,    FITNESS    FOR    A   PARTICULAR    PURPOSE    AND<a name="line.18"></a>
<span class="sourceLineNo">019</span> * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE<a name="line.19"></a>
<span class="sourceLineNo">020</span> * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION<a name="line.20"></a>
<span class="sourceLineNo">021</span> * OF CONTRACT, TORT OR OTHERWISE,  ARISING FROM, OUT OF OR IN CONNECTION<a name="line.21"></a>
<span class="sourceLineNo">022</span> * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.<a name="line.22"></a>
<span class="sourceLineNo">023</span> *<a name="line.23"></a>
<span class="sourceLineNo">024</span> */<a name="line.24"></a>
<span class="sourceLineNo">025</span>package org.slf4j.ext;<a name="line.25"></a>
<span class="sourceLineNo">026</span><a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.slf4j.Logger;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.slf4j.Marker;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.slf4j.MarkerFactory;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.slf4j.helpers.FormattingTuple;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.slf4j.helpers.MessageFormatter;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.slf4j.spi.LocationAwareLogger;<a name="line.32"></a>
<span class="sourceLineNo">033</span><a name="line.33"></a>
<span class="sourceLineNo">034</span>/**<a name="line.34"></a>
<span class="sourceLineNo">035</span> * A utility that provides standard mechanisms for logging certain kinds of<a name="line.35"></a>
<span class="sourceLineNo">036</span> * activities.<a name="line.36"></a>
<span class="sourceLineNo">037</span> * <a name="line.37"></a>
<span class="sourceLineNo">038</span> * @author Ralph Goers<a name="line.38"></a>
<span class="sourceLineNo">039</span> * @author Ceki G&amp;uuml;lc&amp;uuml;<a name="line.39"></a>
<span class="sourceLineNo">040</span> */<a name="line.40"></a>
<span class="sourceLineNo">041</span>public class XLogger extends LoggerWrapper implements Logger {<a name="line.41"></a>
<span class="sourceLineNo">042</span><a name="line.42"></a>
<span class="sourceLineNo">043</span>    private static final String FQCN = XLogger.class.getName();<a name="line.43"></a>
<span class="sourceLineNo">044</span>    static Marker FLOW_MARKER = MarkerFactory.getMarker("FLOW");<a name="line.44"></a>
<span class="sourceLineNo">045</span>    static Marker ENTRY_MARKER = MarkerFactory.getMarker("ENTRY");<a name="line.45"></a>
<span class="sourceLineNo">046</span>    static Marker EXIT_MARKER = MarkerFactory.getMarker("EXIT");<a name="line.46"></a>
<span class="sourceLineNo">047</span><a name="line.47"></a>
<span class="sourceLineNo">048</span>    static Marker EXCEPTION_MARKER = MarkerFactory.getMarker("EXCEPTION");<a name="line.48"></a>
<span class="sourceLineNo">049</span>    static Marker THROWING_MARKER = MarkerFactory.getMarker("THROWING");<a name="line.49"></a>
<span class="sourceLineNo">050</span>    static Marker CATCHING_MARKER = MarkerFactory.getMarker("CATCHING");<a name="line.50"></a>
<span class="sourceLineNo">051</span><a name="line.51"></a>
<span class="sourceLineNo">052</span>    static String EXIT_MESSAGE_0 = "exit";<a name="line.52"></a>
<span class="sourceLineNo">053</span>    static String EXIT_MESSAGE_1 = "exit with ({})";<a name="line.53"></a>
<span class="sourceLineNo">054</span><a name="line.54"></a>
<span class="sourceLineNo">055</span>    static String ENTRY_MESSAGE_0 = "entry";<a name="line.55"></a>
<span class="sourceLineNo">056</span>    static String ENTRY_MESSAGE_1 = "entry with ({})";<a name="line.56"></a>
<span class="sourceLineNo">057</span>    static String ENTRY_MESSAGE_2 = "entry with ({}, {})";<a name="line.57"></a>
<span class="sourceLineNo">058</span>    static String ENTRY_MESSAGE_3 = "entry with ({}, {}, {})";<a name="line.58"></a>
<span class="sourceLineNo">059</span>    static String ENTRY_MESSAGE_4 = "entry with ({}, {}, {}, {})";<a name="line.59"></a>
<span class="sourceLineNo">060</span>    static int ENTRY_MESSAGE_ARRAY_LEN = 5;<a name="line.60"></a>
<span class="sourceLineNo">061</span>    static String[] ENTRY_MESSAGE_ARRAY = new String[ENTRY_MESSAGE_ARRAY_LEN];<a name="line.61"></a>
<span class="sourceLineNo">062</span>    static {<a name="line.62"></a>
<span class="sourceLineNo">063</span>        ENTRY_MARKER.add(FLOW_MARKER);<a name="line.63"></a>
<span class="sourceLineNo">064</span>        EXIT_MARKER.add(FLOW_MARKER);<a name="line.64"></a>
<span class="sourceLineNo">065</span>        THROWING_MARKER.add(EXCEPTION_MARKER);<a name="line.65"></a>
<span class="sourceLineNo">066</span>        CATCHING_MARKER.add(EXCEPTION_MARKER);<a name="line.66"></a>
<span class="sourceLineNo">067</span><a name="line.67"></a>
<span class="sourceLineNo">068</span>        ENTRY_MESSAGE_ARRAY[0] = ENTRY_MESSAGE_0;<a name="line.68"></a>
<span class="sourceLineNo">069</span>        ENTRY_MESSAGE_ARRAY[1] = ENTRY_MESSAGE_1;<a name="line.69"></a>
<span class="sourceLineNo">070</span>        ENTRY_MESSAGE_ARRAY[2] = ENTRY_MESSAGE_2;<a name="line.70"></a>
<span class="sourceLineNo">071</span>        ENTRY_MESSAGE_ARRAY[3] = ENTRY_MESSAGE_3;<a name="line.71"></a>
<span class="sourceLineNo">072</span>        ENTRY_MESSAGE_ARRAY[4] = ENTRY_MESSAGE_4;<a name="line.72"></a>
<span class="sourceLineNo">073</span>    }<a name="line.73"></a>
<span class="sourceLineNo">074</span><a name="line.74"></a>
<span class="sourceLineNo">075</span>    public enum Level {<a name="line.75"></a>
<span class="sourceLineNo">076</span>        TRACE("TRACE", LocationAwareLogger.TRACE_INT), DEBUG("DEBUG", LocationAwareLogger.DEBUG_INT), INFO("INFO", LocationAwareLogger.INFO_INT), WARN("WARN",<a name="line.76"></a>
<span class="sourceLineNo">077</span>                        LocationAwareLogger.WARN_INT), ERROR("ERROR", LocationAwareLogger.ERROR_INT);<a name="line.77"></a>
<span class="sourceLineNo">078</span><a name="line.78"></a>
<span class="sourceLineNo">079</span>        private final String name;<a name="line.79"></a>
<span class="sourceLineNo">080</span>        private final int level;<a name="line.80"></a>
<span class="sourceLineNo">081</span><a name="line.81"></a>
<span class="sourceLineNo">082</span>        public String toString() {<a name="line.82"></a>
<span class="sourceLineNo">083</span>            return this.name;<a name="line.83"></a>
<span class="sourceLineNo">084</span>        }<a name="line.84"></a>
<span class="sourceLineNo">085</span><a name="line.85"></a>
<span class="sourceLineNo">086</span>        public int intValue() {<a name="line.86"></a>
<span class="sourceLineNo">087</span>            return this.level;<a name="line.87"></a>
<span class="sourceLineNo">088</span>        }<a name="line.88"></a>
<span class="sourceLineNo">089</span><a name="line.89"></a>
<span class="sourceLineNo">090</span>        private Level(String name, int level) {<a name="line.90"></a>
<span class="sourceLineNo">091</span>            this.name = name;<a name="line.91"></a>
<span class="sourceLineNo">092</span>            this.level = level;<a name="line.92"></a>
<span class="sourceLineNo">093</span>        }<a name="line.93"></a>
<span class="sourceLineNo">094</span>    }<a name="line.94"></a>
<span class="sourceLineNo">095</span><a name="line.95"></a>
<span class="sourceLineNo">096</span>    /**<a name="line.96"></a>
<span class="sourceLineNo">097</span>     * Given an underlying logger, construct an XLogger<a name="line.97"></a>
<span class="sourceLineNo">098</span>     * <a name="line.98"></a>
<span class="sourceLineNo">099</span>     * @param logger<a name="line.99"></a>
<span class="sourceLineNo">100</span>     *          underlying logger<a name="line.100"></a>
<span class="sourceLineNo">101</span>     */<a name="line.101"></a>
<span class="sourceLineNo">102</span>    public XLogger(Logger logger) {<a name="line.102"></a>
<span class="sourceLineNo">103</span>        // If class B extends A, assuming B does not override method x(), the caller<a name="line.103"></a>
<span class="sourceLineNo">104</span>        // of new B().x() is A and not B, see also<a name="line.104"></a>
<span class="sourceLineNo">105</span>        // http://jira.qos.ch/browse/SLF4J-105<a name="line.105"></a>
<span class="sourceLineNo">106</span>        super(logger, LoggerWrapper.class.getName());<a name="line.106"></a>
<span class="sourceLineNo">107</span>    }<a name="line.107"></a>
<span class="sourceLineNo">108</span><a name="line.108"></a>
<span class="sourceLineNo">109</span>    /**<a name="line.109"></a>
<span class="sourceLineNo">110</span>     * Log method entry.<a name="line.110"></a>
<span class="sourceLineNo">111</span>     * <a name="line.111"></a>
<span class="sourceLineNo">112</span>     * @param argArray<a name="line.112"></a>
<span class="sourceLineNo">113</span>     *          supplied parameters<a name="line.113"></a>
<span class="sourceLineNo">114</span>     */<a name="line.114"></a>
<span class="sourceLineNo">115</span>    public void entry(Object... argArray) {<a name="line.115"></a>
<span class="sourceLineNo">116</span>        if (instanceofLAL &amp;&amp; logger.isTraceEnabled(ENTRY_MARKER)) {<a name="line.116"></a>
<span class="sourceLineNo">117</span>            String messagePattern = null;<a name="line.117"></a>
<span class="sourceLineNo">118</span>            if (argArray.length &lt; ENTRY_MESSAGE_ARRAY_LEN) {<a name="line.118"></a>
<span class="sourceLineNo">119</span>                messagePattern = ENTRY_MESSAGE_ARRAY[argArray.length];<a name="line.119"></a>
<span class="sourceLineNo">120</span>            } else {<a name="line.120"></a>
<span class="sourceLineNo">121</span>                messagePattern = buildMessagePattern(argArray.length);<a name="line.121"></a>
<span class="sourceLineNo">122</span>            }<a name="line.122"></a>
<span class="sourceLineNo">123</span>            FormattingTuple tp = MessageFormatter.arrayFormat(messagePattern, argArray);<a name="line.123"></a>
<span class="sourceLineNo">124</span>            ((LocationAwareLogger) logger).log(ENTRY_MARKER, FQCN, LocationAwareLogger.TRACE_INT, tp.getMessage(), argArray, tp.getThrowable());<a name="line.124"></a>
<span class="sourceLineNo">125</span>        }<a name="line.125"></a>
<span class="sourceLineNo">126</span>    }<a name="line.126"></a>
<span class="sourceLineNo">127</span><a name="line.127"></a>
<span class="sourceLineNo">128</span>    /**<a name="line.128"></a>
<span class="sourceLineNo">129</span>     * Log method exit<a name="line.129"></a>
<span class="sourceLineNo">130</span>     */<a name="line.130"></a>
<span class="sourceLineNo">131</span>    public void exit() {<a name="line.131"></a>
<span class="sourceLineNo">132</span>        if (instanceofLAL &amp;&amp; logger.isTraceEnabled(ENTRY_MARKER)) {<a name="line.132"></a>
<span class="sourceLineNo">133</span>            ((LocationAwareLogger) logger).log(EXIT_MARKER, FQCN, LocationAwareLogger.TRACE_INT, EXIT_MESSAGE_0, null, null);<a name="line.133"></a>
<span class="sourceLineNo">134</span>        }<a name="line.134"></a>
<span class="sourceLineNo">135</span>    }<a name="line.135"></a>
<span class="sourceLineNo">136</span><a name="line.136"></a>
<span class="sourceLineNo">137</span>    /**<a name="line.137"></a>
<span class="sourceLineNo">138</span>     * Log method exit<a name="line.138"></a>
<span class="sourceLineNo">139</span>     * <a name="line.139"></a>
<span class="sourceLineNo">140</span>     * @param result<a name="line.140"></a>
<span class="sourceLineNo">141</span>     *          The result of the method being exited<a name="line.141"></a>
<span class="sourceLineNo">142</span>     */<a name="line.142"></a>
<span class="sourceLineNo">143</span>    public &lt;T&gt; T exit(T result) {<a name="line.143"></a>
<span class="sourceLineNo">144</span>        if (instanceofLAL &amp;&amp; logger.isTraceEnabled(ENTRY_MARKER)) {<a name="line.144"></a>
<span class="sourceLineNo">145</span>            FormattingTuple tp = MessageFormatter.format(EXIT_MESSAGE_1, result);<a name="line.145"></a>
<span class="sourceLineNo">146</span>            ((LocationAwareLogger) logger).log(EXIT_MARKER, FQCN, LocationAwareLogger.TRACE_INT, tp.getMessage(), new Object[] { result }, tp.getThrowable());<a name="line.146"></a>
<span class="sourceLineNo">147</span>        }<a name="line.147"></a>
<span class="sourceLineNo">148</span>        return result;<a name="line.148"></a>
<span class="sourceLineNo">149</span>    }<a name="line.149"></a>
<span class="sourceLineNo">150</span><a name="line.150"></a>
<span class="sourceLineNo">151</span>    /**<a name="line.151"></a>
<span class="sourceLineNo">152</span>     * Log an exception being thrown. The generated log event uses Level ERROR.<a name="line.152"></a>
<span class="sourceLineNo">153</span>     * <a name="line.153"></a>
<span class="sourceLineNo">154</span>     * @param throwable<a name="line.154"></a>
<span class="sourceLineNo">155</span>     *          the exception being caught.<a name="line.155"></a>
<span class="sourceLineNo">156</span>     */<a name="line.156"></a>
<span class="sourceLineNo">157</span>    public &lt;T extends Throwable&gt; T throwing(T throwable) {<a name="line.157"></a>
<span class="sourceLineNo">158</span>        if (instanceofLAL) {<a name="line.158"></a>
<span class="sourceLineNo">159</span>            ((LocationAwareLogger) logger).log(THROWING_MARKER, FQCN, LocationAwareLogger.ERROR_INT, "throwing", null, throwable);<a name="line.159"></a>
<span class="sourceLineNo">160</span>        }<a name="line.160"></a>
<span class="sourceLineNo">161</span>        return throwable;<a name="line.161"></a>
<span class="sourceLineNo">162</span>    }<a name="line.162"></a>
<span class="sourceLineNo">163</span><a name="line.163"></a>
<span class="sourceLineNo">164</span>    /**<a name="line.164"></a>
<span class="sourceLineNo">165</span>     * Log an exception being thrown allowing the log level to be specified.<a name="line.165"></a>
<span class="sourceLineNo">166</span>     * <a name="line.166"></a>
<span class="sourceLineNo">167</span>     * @param level<a name="line.167"></a>
<span class="sourceLineNo">168</span>     *          the logging level to use.<a name="line.168"></a>
<span class="sourceLineNo">169</span>     * @param throwable<a name="line.169"></a>
<span class="sourceLineNo">170</span>     *          the exception being caught.<a name="line.170"></a>
<span class="sourceLineNo">171</span>     */<a name="line.171"></a>
<span class="sourceLineNo">172</span>    public &lt;T extends Throwable&gt; T throwing(Level level, T throwable) {<a name="line.172"></a>
<span class="sourceLineNo">173</span>        if (instanceofLAL) {<a name="line.173"></a>
<span class="sourceLineNo">174</span>            ((LocationAwareLogger) logger).log(THROWING_MARKER, FQCN, level.level, "throwing", null, throwable);<a name="line.174"></a>
<span class="sourceLineNo">175</span>        }<a name="line.175"></a>
<span class="sourceLineNo">176</span>        return throwable;<a name="line.176"></a>
<span class="sourceLineNo">177</span>    }<a name="line.177"></a>
<span class="sourceLineNo">178</span><a name="line.178"></a>
<span class="sourceLineNo">179</span>    /**<a name="line.179"></a>
<span class="sourceLineNo">180</span>     * Log an exception being caught. The generated log event uses Level ERROR.<a name="line.180"></a>
<span class="sourceLineNo">181</span>     * <a name="line.181"></a>
<span class="sourceLineNo">182</span>     * @param throwable<a name="line.182"></a>
<span class="sourceLineNo">183</span>     *          the exception being caught.<a name="line.183"></a>
<span class="sourceLineNo">184</span>     */<a name="line.184"></a>
<span class="sourceLineNo">185</span>    public void catching(Throwable throwable) {<a name="line.185"></a>
<span class="sourceLineNo">186</span>        if (instanceofLAL) {<a name="line.186"></a>
<span class="sourceLineNo">187</span>            ((LocationAwareLogger) logger).log(CATCHING_MARKER, FQCN, LocationAwareLogger.ERROR_INT, "catching", null, throwable);<a name="line.187"></a>
<span class="sourceLineNo">188</span>        }<a name="line.188"></a>
<span class="sourceLineNo">189</span>    }<a name="line.189"></a>
<span class="sourceLineNo">190</span><a name="line.190"></a>
<span class="sourceLineNo">191</span>    /**<a name="line.191"></a>
<span class="sourceLineNo">192</span>     * Log an exception being caught allowing the log level to be specified.<a name="line.192"></a>
<span class="sourceLineNo">193</span>     * <a name="line.193"></a>
<span class="sourceLineNo">194</span>     * @param level<a name="line.194"></a>
<span class="sourceLineNo">195</span>     *          the logging level to use.<a name="line.195"></a>
<span class="sourceLineNo">196</span>     * @param throwable<a name="line.196"></a>
<span class="sourceLineNo">197</span>     *          the exception being caught.<a name="line.197"></a>
<span class="sourceLineNo">198</span>     */<a name="line.198"></a>
<span class="sourceLineNo">199</span>    public void catching(Level level, Throwable throwable) {<a name="line.199"></a>
<span class="sourceLineNo">200</span>        if (instanceofLAL) {<a name="line.200"></a>
<span class="sourceLineNo">201</span>            ((LocationAwareLogger) logger).log(CATCHING_MARKER, FQCN, level.level, "catching", null, throwable);<a name="line.201"></a>
<span class="sourceLineNo">202</span>        }<a name="line.202"></a>
<span class="sourceLineNo">203</span>    }<a name="line.203"></a>
<span class="sourceLineNo">204</span><a name="line.204"></a>
<span class="sourceLineNo">205</span>    private static String buildMessagePattern(int len) {<a name="line.205"></a>
<span class="sourceLineNo">206</span>        StringBuilder sb = new StringBuilder();<a name="line.206"></a>
<span class="sourceLineNo">207</span>        sb.append(" entry with (");<a name="line.207"></a>
<span class="sourceLineNo">208</span>        for (int i = 0; i &lt; len; i++) {<a name="line.208"></a>
<span class="sourceLineNo">209</span>            sb.append("{}");<a name="line.209"></a>
<span class="sourceLineNo">210</span>            if (i != len - 1)<a name="line.210"></a>
<span class="sourceLineNo">211</span>                sb.append(", ");<a name="line.211"></a>
<span class="sourceLineNo">212</span>        }<a name="line.212"></a>
<span class="sourceLineNo">213</span>        sb.append(')');<a name="line.213"></a>
<span class="sourceLineNo">214</span>        return sb.toString();<a name="line.214"></a>
<span class="sourceLineNo">215</span>    }<a name="line.215"></a>
<span class="sourceLineNo">216</span>}<a name="line.216"></a>




























































</pre>
</div>
</body>
</html>
